home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / merge1.arc / MERGE17.DOC < prev    next >
Encoding:
Text File  |  1987-10-15  |  19.1 KB  |  515 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                   Operation Manual
  10.  
  11.                                  Merge Version 1.7
  12.  
  13.                                   by Dave Haberle
  14.  
  15.                                    Copyright 1987
  16.  
  17.                                 All rights reserved
  18.  
  19.  
  20.          *** WHAT IS MERGE? ***
  21.  
  22.          MERGE  is  a program which merges ASCII data files with ASCII text
  23.          files. It's a shareware version of a  "mail-merge"  program  which
  24.          merges  address  files with letters to produce form letters. It is
  25.          provided in compiled form as a ready-to-run EXE  file.  MERGE is a
  26.          perfect  companion  for  word  processing programs such as GALAXY,
  27.          WordStar, and others which have ASCII file capability.
  28.  
  29.          *** SYSTEM REQUIREMENTS ***
  30.  
  31.          MERGE  should  run  on  even the most minimally equipped MS-DOS or
  32.          CP/M computer. Graphics options are not required. The  program  is
  33.          available  in  two  forms:  as  an EXEcutable file or in Microsoft
  34.          Basic. The BASIC version should run on most  computers  in  either
  35.          the  MS-DOS  or  CP/M  environments.  The  BASIC  source  code  is
  36.          available. The EXE version is for MS-DOS computers while the basic
  37.          version should work on most  any  computer  which  uses  Microsoft
  38.          Basic  version  5.2  or  later.  The  compiler used is Microsoft's
  39.          QuickBasic compiler, version  3.0.  The  basic  version  has  been
  40.          tested  on both MS-DOS and CP/M machines and works satisfactorily.
  41.          The only problem which might occur with different computers is the
  42.          clear-screen function, which in Microsoft  Basic  is  CLS.  (Apple
  43.          computers  using CP/M, for instance, use the command HOME in place
  44.          of CLS.) Because of this, the author  provides  the  source  basic
  45.          version so that users might change the CLS function to accommodate
  46.          their computers.
  47.  
  48.  
  49.          *** SHAREWARE CONCEPT ***
  50.  
  51.          MERGE  is provided as shareware. It is not public domain software.
  52.          Users are free to copy it and distribute it as long  as  any  fees
  53.          involved  are  of  a  token  nature to cover the cost of media and
  54.          postage, in any event not  to  exceed  $5.00  U.S.  The  shareware
  55.          principle  encourages  users  to try software before buying it; if
  56.          you decide to use MERGE, the author requests a  token  payment  of
  57.          $7.00  U.S.  to register your copy. In return for the registration
  58.          fee, you'll receive a current version, the  source  code,  and  an
  59.          operation  manual complete with time-saving tips on using MERGE to
  60.          enhance your  written  communications.  For  your  convenience,  a
  61.          registration form is included at the end of this documentation.
  62.  
  63.  
  64.                                Merge17 - Page 1
  65.  
  66.  
  67.  
  68.          *** PROGRAM FEATURES ***
  69.  
  70.          MERGE is not intended to be the consummate mail-merge program.  It
  71.          is  quick,  easy  to  use, and is a perfect companion for computer
  72.          users who either do not now have such a  function  available  with
  73.          their  word  processors  or  who want an easier way to get the job
  74.          done than their current mail-merge  program  provides.  Therefore,
  75.          MERGE  offers "the basics," with a few nice conveniences thrown in
  76.          for good measure.
  77.  
  78.          In short, MERGE works with ASCII files from  any  ASCII-type  word
  79.          processor  or database system, supports all drive designations and
  80.          subdirectories, accommodates multiple-page form letters, up to  20
  81.          variables (FLAGS) per letter, multiple variables (FLAGS) per line,
  82.          single-sheet  or  form  feed paper stock, suspend/resume printing,
  83.          ESCape/cancel job, forced page advance, starting with any selected
  84.          record in the data file, and imbedded comment lines in a document.
  85.  
  86.          MERGE reserves the following flags for system use:  &DATE,  &PAGE,
  87.          and &NOTE. These are further explained later.
  88.  
  89.          Keyboard data entry may be used in place of data from a disk file,
  90.          allowing single letters to be printed.
  91.  
  92.  
  93.          *** HOW MERGE WORKS ***
  94.  
  95.          MERGE reads a set of data from the specified data file, and a line
  96.          of  ASCII text from a document. It then scans the line for a piece
  97.          of text called a "flag," and if it finds a match with the  "flags"
  98.          designed for that document, it swaps the appropriate text from the
  99.          data  file  with  the  "flag."  After  scanning  the line for each
  100.          "flag," it then prints the line  and  repeats  the  process  until
  101.          either the data file is empty or the user has cancelled operation.
  102.          MERGE  keeps  all  values  for each "flag" for the duration of the
  103.          document currently being printed, so once a set of  data  is  read
  104.          from  the data file, it can be used anywhere in the document until
  105.          the next set of data and the next document is to be printed.
  106.  
  107.  
  108.          *** FILES USED BY THE SYSTEM ***
  109.  
  110.               To operate, MERGE requires 4 files:
  111.  
  112.                   MERGE17.EXE  -- The main program file
  113.                   MERGE.FLG    -- The "flags" to look for in the letter
  114.                   FILENAME.EXT -- Your DOCUMENT file
  115.                   FILENAME.EXT -- Your DATA file
  116.  
  117.          Included  in the ARChive of MERGE may be other files, but they are
  118.          included as helpful aids and are  not  essential  to  running  the
  119.          program.  (Note:  As  of  the  date  of  this  writing,  MERGE had
  120.          undergone 7 revisions,  and  the  current  version  was  1.7.  The
  121.          filename is MERGE17.EXE, denoting the current version.)
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                Merge17 - Page 2
  129.  
  130.  
  131.  
  132.          *** HOW TO RUN MERGE ***
  133.  
  134.          Start  MERGE  by  typing MERGE if using MERGE.EXE or by installing
  135.          BASIC first, if using MERGE.BAS. The greeting will appear  on  the
  136.          screen. Press SPACEBAR to view  the  menu.  To  keep  the  program
  137.          simple,  there  are  only 4 options, one of which is to quit. Type
  138.          the number of the option you desire and press return.
  139.  
  140.          If you're new to merging mailing lists with letters, the following
  141.          general sequence of actions is required to put out form letters:
  142.  
  143.                 1. Create the letter (document) with your word processor.
  144.  
  145.                 2. In the appropriate places in your letter, insert the
  146.                    "flags" you want MERGE to look for and replace with
  147.                    actual data from your address/data file.
  148.  
  149.                 3. Store the letter with a name like INVIT.DOC.
  150.  
  151.                 4. Create the address (data) file with your word processor
  152.                    (or your database program).
  153.  
  154.                 5. Make certain that each record within the file follows
  155.                    the same sequence, such as name, company, street, city,
  156.                    state, zip, salutation.  Make each entry on a line by
  157.                    itself, flush left.  (In this example, 7 pieces of data
  158.                    comprise each record -- 7 lines of information.  Each
  159.                    subsequent record must also be 7 lines long in the same
  160.                    exact order.)
  161.  
  162.                 6. Store the data with a name like INVIT.DAT.  (Notice that
  163.                    the filenames relate to one another.  This makes it
  164.                    easier to remember what data goes with what document.)
  165.  
  166.                 7. Start MERGE.
  167.  
  168.                 8. Select option #1 to CREATE document flags. Type the
  169.                    flags you specified in the letter, following the same
  170.                    order in which the data is stored in the data file. (In
  171.                    the example above, the flags might be &NAME, &COMPANY,
  172.                    &STREET, &CITY, &STATE, &ZIP, and &SALUT.)
  173.  
  174.                 9. Select option #2 to LOAD and DISPLAY the document flags.
  175.                    This ensures that the MERGE.FLG file is correct and that
  176.                    the flags are properly loaded into memory.
  177.  
  178.                10. Select option #3 to MERGE the text and data.  Then type
  179.                    the name of the document to use, then the name of the
  180.                    data file to use, the record number in the data file to
  181.                    start printing from (you can skip forward to any
  182.                    record), the date each letter is to have (or none), and
  183.                    whether using single-sheet manual feed or continuous
  184.                    form paper stock.
  185.  
  186.                11. If all is correct, the letters will then be printed for
  187.                    you according to the parameters you've designed.
  188.  
  189.                12. When complete, the program will return to the menu.
  190.  
  191.  
  192.                                   Merge17 - Page 3
  193.  
  194.  
  195.  
  196.  
  197.          *** PROGRAM LIMITATIONS ***
  198.  
  199.          Your  letters (documents) should be straight ASCII text in WYSIWYG
  200.          format, i.e. "what you see is what you get." MERGE does  not  read
  201.          imbedded  format  commands,  margins, special printer commands for
  202.          boldfacing,  underlining,   etc.,   hence   the   straight   ASCII
  203.          requirement.  (MERGE may work with some printer commands, but this
  204.          would be accidental, not intentional.)
  205.  
  206.          A  carriage return MUST be at the end of each line of text in both
  207.          the document and in the data file to be merged with the document.
  208.  
  209.          More  than  one "flag" may be printed per line, but results may be
  210.          unsatisfactory if abused. MERGE will insert text  into  any  line,
  211.          but  in  so  doing,  it's possible that the data inserted into the
  212.          line may be larger than originally intended (example: a very  long
  213.          name),  thus  forcing  the  right-hand  margin  to  be thrown off.
  214.          Experiments with multiple flags per line have been successful with
  215.          flags such as &SALUT and &LSTNAME, for example,  where  &SALUT  is
  216.          Mr.,  Ms.,  Dr.,  etc.  and  &LSTNAME  is  the  last  name  of the
  217.          addressee.
  218.  
  219.          Envelopes can be printed by using only  the  flags  which  contain
  220.          valid  address-type  data  by  creating a document with the proper
  221.          flags positioned so that the text is printed well to the right  of
  222.          the  left  margin,  i.e.  near the center of the envelope. Use the
  223.          single-sheet option for  this  if  you  try  it.
  224.  
  225.  
  226.          *** USING &DATE, &PAGE AND &NOTE ***
  227.  
  228.          These  flags  are  reserved for system use, and cannot contain any
  229.          data from your database file. &DATE is entered from the  keyboard.
  230.          A  simple  <RETURN>  leaves it blank. When MERGE encounters a line
  231.          with &PAGE in it, MERGE issues a form-feed  without  printing  the
  232.          line.  Therefore,  &PAGE  should reside on a line by itself. &PAGE
  233.          allows you to have greater control of multiple-page documents.
  234.  
  235.          &NOTE allows comments to be inserted into the document  which  are
  236.          not printed. The line should BEGIN with &NOTE, after which you may
  237.          type   your   comments.   &NOTE  should  be  on  each  line  of  a
  238.          multiple-line comment.
  239.  
  240.  
  241.          *** A WORKING EXAMPLE ***
  242.  
  243.          A sample letter, the  contents  of  the  MERGE.FLG  file  for  the
  244.          letter, and sample data follow. Often the best way to learn how to
  245.          use a program is to try out a working sample.
  246.  
  247.          A typical letter using 7 document flags (excluding &DATE, which is
  248.          pre-set  by  the  system)  might appear like this one. It might be
  249.          called INVIT.DOC on the disk:
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.                                Merge17 - Page 4
  257.  
  258.  
  259.  
  260.                         (--- beginning of letter ---)
  261.  
  262.          &NOTE Use INVIT.DAT file - OPEN HOUSE INVITATION 1987
  263.          &NOTE Align paper at line where printing is to start
  264.          &DATE
  265.  
  266.  
  267.          &FULLNAME
  268.          &COMPANY
  269.          &STREET
  270.          &CITY, &STATE &ZIP
  271.  
  272.  
  273.          Dear &SALUT:
  274.  
  275.          Please accept my personal invitation to the groundbreaking
  276.          ceremony for our new building, October 17th at nine o'clock in the
  277.          morning.
  278.  
  279.          Refreshments will be served prior to and following the cutting of
  280.          the ribbon, with a tour of our new computer installation winding
  281.          up the morning.
  282.  
  283.          These are exciting times for our company, and I hope your schedule
  284.          is free on the 17th so you can be with us.  Please RSVP to my
  285.          secretary, Lois at (612) 941-8519.
  286.  
  287.          Hope to see you there!
  288.  
  289.          Sincerely yours,
  290.  
  291.  
  292.  
  293.  
  294.          Dave Haberle
  295.          President
  296.  
  297.          DH:lj
  298.  
  299.                              (----- end of letter -----)
  300.  
  301.          The MERGE.FLG file for the above would contain  7  items  (in  any
  302.          order  but  it's easier to keep track if they're in the same order
  303.          they first appear in the text of the letter). Bear in  mind,  this
  304.          file would be flush left, not indented as printed below:
  305.  
  306.          &FULLNAME
  307.          &COMPANY
  308.          &STREET
  309.          &CITY
  310.          &STATE
  311.          &ZIP
  312.          &SALUT
  313.  
  314.          Following is a sample 4-record data file which could be used  with
  315.          this  letter  and set of flags. Again, this would be flush left so
  316.          that  no  characters  precede  the  entries.   Notice   that   the
  317.          information is typed in the same order as defined in the MERGE.FLG
  318.          file, and each record is 7 lines long -- one line for each flag.
  319.  
  320.                                Merge17 - Page 5
  321.  
  322.  
  323.  
  324.  
  325.          This file could perhaps be named INVIT.DAT which  you'd  recognize
  326.          later on as being the companion data file for INVIT.DOC.
  327.  
  328.          Mr. Richard Stensrud
  329.          Wilkening Tile Company
  330.          118 First Avenue North
  331.          Mankato
  332.          MN
  333.          55132
  334.          Mr. Stensrud
  335.          Mr. Andrew W. Hodge
  336.          Tinsdale Bearing, Inc.
  337.          201 East Plaines Blvd.
  338.          Chicago
  339.          IL
  340.          60611
  341.          Andy
  342.          Ms. Eileen F. Jurgenson
  343.          Jurgenson Marketing Associates
  344.          P.O. Box 347
  345.          Kansas City
  346.          MO
  347.          44678
  348.          Ms. Jurgenson
  349.  
  350.          Mr. Carl Dedersbach
  351.          4187 Terrace Drive
  352.          Kearney
  353.          NE
  354.          42022
  355.          Carl
  356.  
  357.          (Notice  the  blank  line  after  Ms.  Jurgenson  and  before  Mr.
  358.          Dedersbach. In this instance, because there was no  info  to  fill
  359.          the  &COMPANY  flag,  the &FULLNAME was given a blank line and the
  360.          name was typed in the place normally reserved for &COMPANY. If the
  361.          blank line is on the &COMPANY line, when the letter is printed  it
  362.          will  have  a  blank line within the address heading on the letter
  363.          since the &COMPANY  flag  is  in  the  2nd  line  of  the  address
  364.          heading.)
  365.  
  366.          After  the  letters are printed, another document could be created
  367.          to address the envelopes. Using the same data file and  flags,  it
  368.          could look like the following:
  369.  
  370.                                                 &FULLNAME
  371.                                                 &COMPANY
  372.                                                 &STREET
  373.                                                 &CITY, &STATE &ZIP
  374.  
  375.          Even  though  using  the  same  FLAGS  and the same DATA file, the
  376.          &SALUT and &DATE variables won't be  printed  because  there's  no
  377.          need  for  them  on the envelope. Then by using the "single sheet"
  378.          option,  individual  envelopes  may  be   inserted   and   printed
  379.          automatically, in the same order as the letters were printed. This
  380.          "document"  is  very  short  (only 4 lines) but could be extremely
  381.          helpful to have on hand.
  382.  
  383.  
  384.                                Merge17 - Page 6
  385.  
  386.  
  387.  
  388.          You could also include the &PAGE command at the end of the letter,
  389.          and for the 2nd "page" of the letter,  use  the  above  format  to
  390.          print  the  envelope immediately after the letter. You'd also need
  391.          to use the single-sheet option as well for this to work properly.
  392.  
  393.  
  394.          *** FILES INCLUDED IN THE ARCHIVE OF MERGE ***
  395.  
  396.          MERGE may be found on many  bulletin  board  systems  or  national
  397.          computer services in its ARChive form, MERGE17.ARC.
  398.  
  399.          Included in this ARChive are the following files:
  400.  
  401.          MERGE17.EXE  -  The executable program file
  402.          MERGE17.DOC  -  Documentation
  403.          INVIT.DOC    -  Sample letter
  404.          INVIT.DAT    -  Sample data file to merge with INVIT.DOC
  405.          MERGE.FLG    -  FLAGS to use with INVIT.DOC & INVIT.DAT
  406.          README.1ST   -  List of the contents of the ARChive file
  407.  
  408.          To  print  the documentation, align your printer to line #1 of the
  409.          first page and type the following: TYPE MERGE17.DOC>PRN
  410.  
  411.  
  412.          *** REGISTRATION ***
  413.  
  414.          On the next page is a registration form for you to use should  you
  415.          wish  to  register your copy. By supporting the shareware software
  416.          concept you'll be helping to spread  the  development  of  useful,
  417.          low-cost software.
  418.  
  419.  
  420.                                     Dave Haberle
  421.                                    GolfSoft's BBS
  422.                                   P.O. Box 442-056
  423.                                Eden Prairie, MN 55344
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.                                   MERGE17 - Page 7
  449.  
  450.  
  451.  
  452.  
  453.  
  454.                **********     MERGE REGISTRATION FORM     **********
  455.  
  456.  
  457.  
  458.  
  459.                                               Date_______________________
  460.  
  461.           Name___________________________________________________________
  462.  
  463.           Address________________________________________________________
  464.  
  465.           City, State__________________________________ Zip______________
  466.  
  467.           Where did you get your copy of MERGE? (Just curious -- I'd like
  468.           to find out where it goes!  Please list the BBS number, or if a
  469.              nationwide system, the system and the file area.  Thanks!)
  470.  
  471.           _______________________________________________________________
  472.  
  473.           What version of MERGE did you get?_____________________________
  474.  
  475.           What would you like to see added to it to make it more useful?
  476.  
  477.           _______________________________________________________________
  478.  
  479.           _______________________________________________________________
  480.  
  481.          Enclose  $7.00,  cash, check, or money order. Send form and fee to
  482.          the address  below.  You'll  get  a  disk  containing  the  latest
  483.          version,  a  complete  operation  manual including tips, the basic
  484.          source code, and some extra utilities which should interest you!
  485.  
  486.  
  487.          GolfSoft  maintains  a  24-hour BBS. If you'd like to log into our
  488.          BBS, use the following parameters: 300 or  1200  bps,  8  data,  1
  489.          stop, no parity. Access telephone number: (612) 941-8519.
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.                             MERGE17 - REGISTRATION FORM
  513.  
  514.  
  515.